Retrieving Receive Updates

To retrieve updates for receives using the Warehouse API, you can use query parameters with the list endpoint. For instance:

GET /warehouse/v1/receives?PrimaryReference=12345678 HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)

Although our query parameters allow you to "poll" for updates within a time range, this approach is not recommended. Due to the distributed nature of our system, there's a slight chance an update might become available through the API after it is updated, which could lead to potentially lost data.

Instead, we highly recommend using the webhooks solution for real-time updates. This ensures that you receive accurate, timely information and minimizes the risk of data loss. For more information about webhooks and how to set them up, please refer to the webhook documentation.

Example Response

{
    "data": {
        "receives": [
            {
                "id": "6672f4bacb76775a3e4cbd7b",
                "dateCreated": "2024-06-19T15:09:46+00:00",
                "dateLastUpdated": "2024-06-19T15:11:17+00:00",
                "warehouseCode": "CLW",
                "primaryReference": "SHP-000001",
                "secondaryReference": "PO-000001",
                "status": "CAN",
                "transportDetail": {},
                "receiveLines": [
                    {
                        "lineNumber": "1",
                        "externalLineReference": "1000",
                        "productCode": "LGT-K380-BT-KYBD",
                        "quantity": 100,
                        "quantityUnit": "UNT",
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": [],
                        "palletId": "P0000000001"
                    }
                ],
                "additionalReferences": [],
                "shipments": [
                    {
                        "id": "6672f4bccb76775a3e4cbd7c",
                        "wmsDocketId": "W01144083",
                        "dateCreated": "2024-06-19T15:09:48+00:00",
                        "dateLastUpdated": "2024-06-19T15:11:17+00:00",
                        "warehouseCode": "CLW",
                        "primaryReference": "SHP-000001",
                        "secondaryReference": "PO-000001",
                        "status": "FIN",
                        "totalQuantity": 100.000,
                        "receiveLines": [
                            {
                                "sublines": [],
                                "lineNumber": "1",
                                "productCode": "LGT-K380-BT-KYBD",
                                "quantity": 100.000,
                                "quantityUnit": "UNT",
                                "lineAttributes": [],
                                "lineCustomAttributes": [],
                                "holdCode": "",
                                "partAttributes": [],
                                "palletId": "P0000000001"
                            }
                        ],
                        "additionalReferences": [],
                        "milestones": [
                            {
                                "code": "WHE",
                                "description": "Created",
                                "sequence": "1",
                                "actualDate": "2024-06-19T15:09:34+00:00"
                            },
                            {
                                "code": "FIN",
                                "description": "Finalized",
                                "sequence": "6",
                                "actualDate": "2024-06-19T15:10:40+00:00"
                            }
                        ]
                    }
                ],
                "tags": [],
                "additionalNotes": []
            }
        ]
    },
    "id": "2d406b49-21f9-4ad7-b79e-dc915b678319",
    "resource": [],
    "errors": []
}